Move documentation to inline comments: GtkHSeparator
authorJavier Jardón <jjardon@gnome.org>
Mon, 11 Apr 2011 21:33:38 +0000 (22:33 +0100)
committerJavier Jardón <jjardon@gnome.org>
Mon, 11 Apr 2011 21:33:38 +0000 (22:33 +0100)
docs/reference/gtk/tmpl/.gitignore
docs/reference/gtk/tmpl/gtkhseparator.sgml [deleted file]
gtk/gtkhseparator.c

index 87a6836029f85e3f88b3b07b494d1f937b733bc8..227c4864a48cbcefe44a30fb7e2dc970843607c5 100644 (file)
@@ -39,6 +39,7 @@ gtkhbox.sgml
 gtkhpaned.sgml
 gtkhscale.sgml
 gtkhscrollbar.sgml
+gtkhseparator.sgml
 gtkiconview.sgml
 gtkimagemenuitem.sgml
 gtkimcontext.sgml
diff --git a/docs/reference/gtk/tmpl/gtkhseparator.sgml b/docs/reference/gtk/tmpl/gtkhseparator.sgml
deleted file mode 100644 (file)
index 9e295cb..0000000
+++ /dev/null
@@ -1,53 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GtkHSeparator
-
-<!-- ##### SECTION Short_Description ##### -->
-A horizontal separator
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-The #GtkHSeparator widget is a horizontal separator, used to group the
-widgets within a window. It displays a horizontal line with a shadow to
-make it appear sunken into the interface.
-</para>
-<note>
-<para>
-The #GtkHSeparator widget is not used as a separator within menus.
-To create a separator in a menu create an empty #GtkSeparatorMenuItem 
-widget using gtk_separator_menu_item_new() and add it to the menu with 
-gtk_menu_shell_append().
-</para>
-</note>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-<variablelist>
-<varlistentry>
-<term>#GtkVSeparator</term>
-<listitem><para>a vertical separator.</para></listitem>
-</varlistentry>
-</variablelist>
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### STRUCT GtkHSeparator ##### -->
-<para>
-The #GtkHSeparator-struct struct contains private data only, and
-should be accessed using the functions below.
-</para>
-
-
-<!-- ##### FUNCTION gtk_hseparator_new ##### -->
-<para>
-Creates a new #GtkHSeparator.
-</para>
-
-@void: 
-@Returns: a new #GtkHSeparator.
-
-
index edbc0c96a38a7f896b20ec9928dd0f282a1cdcdc..49b31d0b9b39d530c6c1a3099bfe51e8a03e38d5 100644 (file)
 #include "gtkorientable.h"
 
 
+/**
+ * SECTION:gtkhseparator
+ * @Short_description: A horizontal separator
+ * @Title: GtkHSeparator
+ * @See_also: #GtkSeparator
+ *
+ * The #GtkHSeparator widget is a horizontal separator, used to group the
+ * widgets within a window. It displays a horizontal line with a shadow to
+ * make it appear sunken into the interface.
+ *
+ * <note>
+ * The #GtkHSeparator widget is not used as a separator within menus.
+ * To create a separator in a menu create an empty #GtkSeparatorMenuItem
+ * widget using gtk_separator_menu_item_new() and add it to the menu with
+ * gtk_menu_shell_append().
+ * </note>
+ */
+
+
 G_DEFINE_TYPE (GtkHSeparator, gtk_hseparator, GTK_TYPE_SEPARATOR)
 
 static void
@@ -44,6 +63,13 @@ gtk_hseparator_init (GtkHSeparator *hseparator)
                                   GTK_ORIENTATION_HORIZONTAL);
 }
 
+/**
+ * gtk_hseparator_new:
+ *
+ * Creates a new #GtkHSeparator.
+ *
+ * Returns: a new #GtkHSeparator.
+ */
 GtkWidget *
 gtk_hseparator_new (void)
 {